Serve local client-config.json if it exists #1038
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matthew-white
commented
Oct 15, 2024
| @@ -95,7 +95,10 @@ http { | |||
| } | |||
|
|
|||
| location = /client-config.json { | |||
| include ./common-headers.nginx.conf; | |||
There was a problem hiding this comment.
We don't call add_header in this location, so I don't think we need to include this file. Locally, I can see that the expected headers are coming through.
There was a problem hiding this comment.
Should this change be a separate PR? It seems to be unrelated to the aim of this PR.
There was a problem hiding this comment.
I would keep this line, as it doesn't do any harm, and keeps this file closer to central's files/nginx/odk.conf.template, and therefore easier to compare.
We could go further in mirroring central's files/nginx/odk.conf.template by adding:
add_header Cache-Control no-cache;
|
I like this approach because it's more consistent with how production behaves. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now that we request client-config.json, I've been wondering whether it'd be possible to remove
npm run dev:oidc. That command sets a single option in the config (oidcEnabled), but there are several other options in the config that a developer might want to set. The idea of this PR is that a developer can create a local client-config.json to match whatever they're working on, and those options won't show up in version control. Modifying src/config.js would have much the same effect, but it has the downside that it shows up in version control.Related: #1034
Before submitting this PR, please make sure you have:
npm run testandnpm run lintand confirmed all checks still pass OR confirm CircleCI build passes